Performing Content Conversion

Step 1: Upload Your Source Document

• Upload the source document that you want to convert.
• This can be a document of any format supported by the PDC RESTful Web Services.
• In response to this request, you will receive a file ID that is used to reference the source document in later requests.

POST http://192.168.0.1:18681/PCCIS/V1/WorkFile?FileExtension=doc
Content-Type: application/octet-stream
[binary data]

200 OK
Content-Type: application/json
{
    "fileId": "5qTYa3gzN9gYUb5SzqUhqg",
}

Step 2: Start the Content Conversion Process

• Using the file ID you obtained for the source document in Step 1, you can now start the process to convert the document. This is accomplished by sending a POST request, which will start a process that runs asynchronously on the PDC server to produce the converted document(s).
• Specify in the POST request the output format to which to convert the source document. This format may be SVG, JPEG, PNG, TIFF, or PDF. PDF to PDF conversion is currently unsupported, however any other supported source format may be converted to one of these five formats.
• For raster output formats (JPEG, TIFF, PNG), you may optionally specify a maxWidth and/or a maxHeight. If either of these attributes is present, then the output document will be scaled to fit them as closely as possible while maintaining its original aspect ratio. At least one of maxWidth and maxHeight must be specified if the source document is in a vector format.
• If output format is PDF or TIFF, you may specify whether to convert each page of the source document to a separate output file or to convert all pages to a single document. This attribute is optional for PDF output, but must be true for TIFF output.

See the "Conversion Input Examples" section below for example JSON strings that can be used as input in to create various ContentCoverter processes.

POST http://192.168.0.1:18681/PCCIS/V1/ContentConverter
Content-Type: application/json
{
    "input": {
        "src": {
            "fileId": "mUiXiqsQuevJKO9Swa32Bd"
        },
        "dest": {
            "format": "pdf",
            "pdfOptions": {
                "forceOneFilePerPage": true
            }
        }
    }
}

200 OK
Content-Type: application/json
{
    "processId": "bQpcuixhvGmNqn5ElskO6Q",
    "expirationDateTime": "2014-12-03T18:30:49.460Z",
    "input": {
        "src": {
            "fileId": "mUiXiqsQuevJKO9Swa32Bd"
        },
        "dest": {
            "format": "pdf",
            "pdfOptions": {
                "forceOneFilePerPage": true
            }
        }
    },
    "state": "processing",
    "percentComplete": 0
}

Step 3: Check Status of the ContentConverter Resource

• The process to generate a converted document(s) runs asynchronously on the PDC server. The POST request you sent in Step 2 will return immediately and before the output is ready. This means you will need to check the status of the process by sending a GET request to the resource you just created.
• In response to this request, JSON will be returned that includes a state property. When this property is complete, the JSON response will also include an output property, which means you can proceed to the next step.
• See the Content Conversion API for more details of this request.

GET http://192.168.0.1:18681/PCCIS/V1/ContentConverter/bQpcuixhvGmNqn5ElskO6Q

200 OK
Content-Type: application/json
{
    "processId": " bQpcuixhvGmNqn5ElskO6Q ",
    "expirationDateTime": "2014-12-03T18:30:49.460Z",
    "input": {
        "src": {
            "fileId": "mUiXiqsQuevJKO9Swa32Bd"
        },
        "dest": {
            "format": "pdf",
            "pdfOptions": {
                "forceOneFilePerPage": true
            }
        }
    },
    "state": "complete",
    "percentComplete": 100,
    "output": {
        "results": [
            {
                "fileId": "ek5Zb123oYHSUEVx1bUrVQ",
                "src": [
                    {
                        "fileId": "mUiXiqsQuevJKO9Swa32Bd",
                        "pages": "1"
                    }
                ]
            }
            {
                "fileId": "KOrSwaqsguevJ97BdmUbXi",
                "src": [
                    {
                        "fileId": "mUiXiqsQuevJKO9Swa32Bd",
                        "pages": "2"
                    }
                ]
            }
            {
                "fileId": "o349chskqw93kwaqsgfevJ",
                "src": [
                    {
                        "fileId": "mUiXiqsQuevJKO9Swa32Bd",
                        "pages": "3"
                    }
                ]
            }
        ]
    }
}

Step 4: Download the Converted Document(s)

• Once the content conversion process completes successfully, the new, converted documents are available for download.
• A work file ID is made available for each successfully converted document in the output property from the JSON response retrieved in Step 3.
• See the Work File API for more details about downloading work files.

GET http://192.168.0.1:18681/PCCIS/V1/WorkFile/ek5Zb123oYHSUEVx1bUrVQ

200 OK
Content-Type: application/pdf
[binary data]

Conversion Input Examples

Below are example JSON strings that can be used as input in Step 2 above to create various ContentCoverter processes.

Multi-Page Word Document to Multi-Page PDF Document

This example will convert all pages of a Word document to a single PDF document.

"input": {
        "src": {
            "fileId": "mUiXiqsQuevJKO9Swa32Bd"
        },
        "dest": {
            "format": "pdf",
            "pdfOptions": {
                "forceOneFilePerPage": false
            }
        }
}

Single-Page Word Document to Scaled PNG Image

This example will convert a single page Word Document to a PNG image, scaled to 800 pixels width. Height will adjust automatically to maintain aspect ratio.

"input": {
        "src": {
            "fileId": "mUiXiqsQuevJKO9Swa32Bd"
        },
        "dest": {
            "format": "png",
            "pngOptions": {
                "maxWidth": "800px"
            }
        }
}

Multi-Page Word Document to Multiple PNG Images

This example will convert a multi-page Word Document to multiple, single page PNG images. As PNG is not a multi-page format, each page of the Word Document will be converted to a separate PNG.

"input": {
        "src": {
            "fileId": "mUiXiqsQuevJKO9Swa32Bd"
        },
        "dest": {
            "format": "pdf"
        }
}

JPEG Image to PNG Image

This example will convert a JPEG image to a PNG image, scaled to fit within 800 pixels width and 600 pixels height. The output PNG will be as large as it can be while maintaining aspect ratio and remaining within these bounds.

"input": {
        "src": {
            "fileId": "mUiXiqsQuevJKO9Swa32Bd"
        },
        "dest": {
            "format": "pdf",
            "pngOptions": {
                "maxWidth": "800px",
                "maxHeight": "600px"
            }
        }
}

©2015. Accusoft Corporation. All Rights Reserved.